home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / c / csource.zip / CSOURCE.DOC next >
Text File  |  1987-08-07  |  7KB  |  155 lines
  1. CSOURCE V1.5
  2. ------------
  3.  
  4.      Thanks for using CSOURCE.  I'm sure it will prove as useful to you
  5. as it does for me.  CSOURCE requires very little printed documentation.  
  6. Most of the help you will need can be obtained through CSOURCE itself.  The
  7. following is a brief summary of how to start CSOURCE and a few other pieces
  8. of information that you may find useful.
  9.  
  10. CHANGES FROM V1.0
  11. -----------------
  12.  
  13.      A stand alone tab removing function has been added ( tab.exe ).  See
  14. the version.doc file for details and other changes from version 1.0.
  15.  
  16. IMPORTANT ADDITIONS
  17. -------------------
  18.  
  19.      Three important features have been added.  CSOURCE now writes to file
  20.      all of the files that were just processed.  That file ( named "c.fls" )
  21.      can be used as input for CSOURCE as follows:  c:> CSOURCE C.FLS
  22.  
  23.      CSOURCE now also writes to file the options you last selected from the 
  24.      main menu.  The file is named "csource.dat" but you never need bother 
  25.      with it.  When CSOURCE is next used, the options you selected last time 
  26.      now become the current default options.  Thanks to David Morgenlender for
  27.      this suggestion.
  28.  
  29.      Users now have the ability to select files via the view directory 
  30.      option.  This is described below.
  31.  
  32.      Old users may notice another new feature.  CSOURCE now displays the 
  33.      memory available to it as the program is running.  This should help
  34.      you determine how many source files or the size of one source file
  35.      CSOURCE can handle given the memory available in your system.
  36.      Displaying the available memory slows CSOURCE down.  Therefore, you
  37.      can toggle the display on and off by pressing the <SPACE BAR>.  This
  38.      is only applicable when CSOURCE is generating a list of identifiers.
  39.  
  40.  
  41. GETTING STARTED
  42. ---------------
  43.  
  44.      To get started, type CSOURCE at the DOS prompt.  You will be presented
  45. with an input screen.  Pressing F2 displays a help screen.  Before the help
  46. screen is displayed, the shareware nature of this product and certain
  47. restrictions are explained.  THIS MUST BE READ BEFORE CSOURCE IS USED. The
  48. help screen shows the various ways possible to enter source files.  There
  49. are basically four ways to enter files:
  50.  
  51.      1.  C>  CSOURCE
  52.          --- No command line parameters.  When CSOURCE sees that there are
  53.              no command line parameters, you are taken directly to the
  54.              input screen where source files are entered manually.
  55.  
  56.      2.  C>  CSOURCE FILES.LST
  57.          --- A file name is passed as a command line parameter.  Since there
  58.              are no wildcard characters in the file name, CSOURCE assumes
  59.              that all the files you wish entered are contained in file
  60.              FILES.LST.  Note that this file name could have contained a full
  61.              drive and path name.  For example, "c:\directory\files.lst"
  62.              would have been perfectly ok.
  63.  
  64.      3.  C>  CSOURCE *.c
  65.          --- The command line parameter contains wildcard characters.  CSOURCE
  66.              will therefore include all files with a ".c" extension.  A drive 
  67.              and path name could be included.  For example,  "c:\directory\*.c"
  68.              will include all ".c" files in the "directory" directory.
  69.  
  70.      4.  View Directory Option.  At the input screen, press the <F5> key to
  71.          view the directory.  The left hand window contains the directory
  72.          listing and the right hand window contains the files already choosen.
  73.          Move the highlite bar over the source file you wish included and 
  74.          press <RETURN>.  If you've choosen more files than can be shown in
  75.          one window, press <F6> to switch windows.  The <PGUP/DN> keys can
  76.          be used to scroll through the already selected files.  Press <F6>
  77.          again to return to the original window.  Pressing <F10> enables you 
  78.          to change the directory.
  79.  
  80.  
  81. INPUT SCREEN
  82. ------------
  83.  
  84.      Only the first method listed above takes you to the input screen.  The
  85. next two cause the input screen to be bypassed.  Once here, entering files
  86. is simple.  If a file name is entered without a drive letter or path name,
  87. the current working directory is searched.  Otherwise, the path name is
  88. searched.
  89.      Wildcard characters are permitted.  Entering "*.c" causes the current
  90. working directory to be searched for all ".c" files.  Entering "c:\*.c"
  91. causes the root directory to be searched for all ".c" files.  When entering
  92. wildcard characters, after the search for files is completed, a message will
  93. be displayed telling you how many files were found.
  94.      If a file cannot be found or a subdirectory does not exist, a message 
  95. will pop up informing you of a problem.  Once the message disappears, you
  96. are free to make any changes you wish to the file name.  You can edit the
  97. line of input using the arrow keys and backspace and delete keys.
  98.      You should also notice a status line on the bottom of the screen giving
  99. more directions.
  100.      The limit on the number of source files that can be entered is 500.
  101.                                        
  102.  
  103.  
  104.  
  105. MAIN MENU
  106. ---------
  107.  
  108.      After the input screen is completed or if you chose to enter files by
  109. either the second or third method listed above, you are taken to the main menu
  110. screen.  All the help you will need can be obtained by positioning the cursor
  111. over a particular field of input and pressing the F1 key.  CSOURCE keeps 
  112. track of where you are in the menu and will display the appropiate help
  113. message.
  114.      One area that may not be clear is extractions.  CSOURCE lets you extract
  115. portions of you code to the screen, printer or a file of your choice.
  116. After you press the F10 key to tell CSOURCE that you are done, you will be
  117. given the chance to extract portions of your source code (assuming you
  118. selected the extract option).  It will look as follows:
  119.  
  120.      Source File:  c:\directory\filename.ext
  121.  
  122.      Extraction #1:  
  123.  
  124. You are allowed 10 extractions.  Enter extractions as follows (where the
  125. numbers are line numbers):
  126.  
  127.      Extraction #1:  45:90    (or)  45-90
  128.      Extraction #2:  121:209  (or)  121-209
  129.      Extraction #3:  300:415  (or)  300-415
  130.      Extraction #4:  (Press <return> to tell CSOURCE you're done)
  131.  
  132. If you entered more than one source file, you will be given the chance to
  133. extract code from each file.
  134.  
  135.  
  136. ERROR CHECKING
  137. --------------
  138.  
  139.      CSOURCE does some error checking on your source code.  It will tell
  140. you if you have mismatched braces, mismatched single or double quotation
  141. marks and mismatched comment symbols.  Since most compilers do not allow
  142. nested comments, CSOURCE will not allow it either.  If you have mismatched
  143. braces, CSOURCE will display a message telling you so but will keep going.  
  144. Any other error causes CSOURCE to stop and tell you the problem and the line
  145. number(s) of occurrence.  You will then be taken back to the DOS prompt to
  146. correct the error and to try again.
  147.  
  148. FOR YOUR INFORMATION
  149. --------------------
  150.  
  151.      CSOURCE was written almost entirely in C and contains approximately 3,700 
  152. lines of code.  One function which handles screen display was written using
  153. inline assembly.  No windowing package was used and approximatly 95% of the
  154. functions used in CSOURCE are either my own or Turbo C's (the compiler used).
  155.